home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus Extra 1997 #1 / Amiga Plus Extra 1997 #1.iso / programme / netz / awdpal / helpdocs / commands < prev    next >
Text File  |  1980-01-07  |  5KB  |  130 lines
  1. Back to MENU
  2. Back to AMAL
  3.  
  4.                        AMAL commands and variables
  5.                        ---------------------------
  6.  
  7. Commands:
  8. ---------
  9.  
  10. AMAL currently has seventeen (!) commands.  These are supplemented
  11. by the Arexx commands unique to each application supporting Arexx.
  12.  
  13. The commands are:
  14.  
  15.     CUTTEXT     DOS         INSERTPATH      INSERTTEXT
  16.     MOVECURSOR  NEWLINE     PASTETEXT       SAVEDOC         SCREEN
  17.     SELECTTEXT  SEND        SETDIRECTORY    SPEAKTO         TYPE
  18.     TYPEERROR   TYPEPORTS   TYPERESULTS
  19.  
  20. Command descriptions:
  21. ---------------------
  22.  
  23. CUTTEXT: syntax CUTTEXT - Cuts the selected text out of the
  24.                           document.
  25.  
  26. DOS: syntax DOS <string> - Executes a dos command.
  27.                            Example: DOS execute hd1:scripts/search
  28.  
  29. INSERTPATH: syntax INSERTPATH {title text} - Prompts a file
  30.                             requestor.  Inserts the selected path
  31.                             into the document.  The optional string
  32.                             {title text} defines the text in the
  33.                             file requestor title bar.
  34.  
  35. INSERTTEXT: syntax 1 - INSERTTEXT <path> 
  36.                             - Inserts the ASCII file <path> into the
  37.                               current document at the position on
  38.                               the cursor.
  39.                      Example: INSERTTEXT hd1:text/template.txt
  40.             syntax 2 - INSERTTEXT SELECTPATH
  41.                             - Prompts the user with a file
  42.                               requestor.
  43.                      Example: INSERTTEXT SELECTPATH
  44.  
  45. MOVECURSOR: syntax 1 - MOVECURSOR UP/DOWN/LEFT/RIGHT <integer>
  46.                         - Moves the cursor in the specified
  47.                           direction <integer> times.
  48.                     Example: MOVECURSOR UP 2
  49.  
  50.                    2 - MOVECURSOR TOSTARTOFLINE/TOENDOFLINE
  51.                         - Moves the cursor to the specified region
  52.                           of the current line.
  53.                     Example: MOVECURSOR TOENDOFLINE
  54.  
  55. NEWLINE: syntax NEWLINE - Simulates a "return" strike on the
  56.                           keyboard at the position of the cursor.
  57.  
  58. PASTETEXT: syntax PASTETEXT - Pastes the text in the clipboard into
  59.                               the document at the position of the
  60.                               cursor.
  61.  
  62. SAVEDOC: syntax 1 - SAVEDOC <path> - Saves the current document to
  63.                                      <path>.
  64.                             Example: SAVEDOC hd1:text/page1.txt
  65.  
  66.                 2 - SAVEDOC SELECTPATH - Prompts the user with a
  67.                                      file requestor before saving.
  68.                             Example: SAVEDOC SELECTPATH
  69.  
  70. SCREEN: syntax SCREEN TOFRONT/TOBACK - Moves the AWebEd screen to
  71.                                          the front or back.
  72.                                 Example: SCREEN TOFRONT
  73.  
  74. SELECTTEXT: syntax SELECTTEXT LINE/WORD - Selects the portion of
  75.                                  text specified by the key word.
  76.                                 Example: SELECTTEXT WORD
  77.  
  78. SEND: syntax SEND <string> - Sends a message to the port specified
  79.                               by "SPEAKTO".  The message is
  80.                               specified by <message>
  81.                                 Example: SEND quit force
  82.  
  83. SETDIRECTORY: syntax 1 - SETDIRECTORY PATH <string> - sets the
  84.                             current directory to the path <string>.
  85.               syntax 2 - SETDIRECTORY PARENT - sets the current
  86.                             directory to the parent of the current
  87.                             directory.
  88.               syntax 3 - SETDIRECTORY PROGDIR - sets the current
  89.                             directory to the program directory.
  90.  
  91.                             NB - The default directory is always the
  92.                             program directory.  Before and after
  93.                             executing an AMAL script AWebEd always
  94.                             reverts to the default directory.
  95.  
  96. SPEAKTO: syntax SPEAKTO <string> - Specifies the Arexx port to send
  97.                                    a message to.  This port is
  98.                                    identified by <port>
  99.                                 Example: SPEAKTO AWEB.1
  100.  
  101. TYPE: syntax TYPE <string> - Inserts the text <string> into the
  102.                              current document at the position of
  103.                              the cursor.
  104.                                 Example: TYPE Greetings
  105.  
  106. TYPEERROR: syntax TYPEERROR - Types the most recently recieved error
  107.                               code into the editing window at the
  108.                               cursor position.
  109.  
  110. TYPEPORTS: syntax TYPEPORTS - Types the currently active ports into
  111.                               the editing window at the cursor
  112.                               position.
  113.  
  114. TYPERESULT: syntax TYPERESULT - Types the most recently returned
  115.                                 message into the editing window at
  116.                                 the cursor position.
  117.  
  118. Variables
  119. ---------
  120.  
  121. AMAL currently supports one (!!!) variable.  All variables must be
  122. in uppercase.
  123.  
  124. Variable description:
  125. ---------------------
  126.  
  127. DOCPATH - the path of the current document.
  128.             Example: SAVEDOC DOCPATH
  129.  
  130. Onto EXAMPLES